<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMime 3.0 Reference Manual: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="description" content="This manual documents the interfaces of the GMime library and has some short notes to help get you up to speed with using the library.">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="next" href="gmime.html" title="Part I. GMime Overview">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="book">
<div class="titlepage">
<div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GMime 3.0 Reference Manual</p></th></tr></table></div>
<div><div class="authorgroup"><div class="author">
<h3 class="author">
<span class="firstname">Jeffrey</span> <span class="surname">Stedfast</span>
</h3>
<div class="affiliation"><div class="address"><p><br>
            <code class="email">&lt;<a class="email" href="mailto:fejj@gnome.org">fejj@gnome.org</a>&gt;</code><br>
          </p></div></div>
</div></div></div>
<div><p class="copyright">Copyright © 2000-2017 Jeffrey Stedfast</p></div>
<div><div class="legalnotice">
<a name="id-1.1.4"></a><p>
        This library is free software; you can redistribute it and/or
        modify it under the terms of the GNU Lesser General Public
        License as published by the Free Software Foundation; either
        version 2.1 of the License, or (at your option) any later version.
      </p>
<p>
        This library is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Lesser General Public License for more details.
      </p>
<p>
        You should have received a copy of the GNU Lesser General Public
        License along with this library; if not, write to the Free Software
        Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
        02110-1301, USA.
      </p>
</div></div>
<div><div class="abstract">
<p class="title"><b>Abstract</b></p>
<p>This manual documents the interfaces of the GMime
      library and has some short notes to help get you up to speed
      with using the library.</p>
</div></div>
</div>
<hr>
</div>
<div class="toc"><dl class="toc">
<dt><span class="part"><a href="gmime.html">I. GMime Overview</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-building.html">Compiling the GMime libraries</a></span><span class="refpurpose"> — How to compile GMime itself</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-compiling.html">Compiling GMime Applications</a></span><span class="refpurpose"> — 
How to compile your GMime application
</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-2-0.html">Changes from 1.0 to 2.0</a></span><span class="refpurpose"> — 
Incompatible changes made between version 1.0 and version 2.0
</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-2-2.html">Changes from 2.0 to 2.2</a></span><span class="refpurpose"> — Incompatible changes made between version 2.0 and version 2.2</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-2-4.html">Changes from 2.2 to 2.4</a></span><span class="refpurpose"> — Changes made between version 2.2 and version 2.4</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-2-6.html">Changes from 2.4 to 2.6</a></span><span class="refpurpose"> — Changes made between version 2.4 and version 2.6</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-3-0.html">Changes from 2.6 to 3.0</a></span><span class="refpurpose"> — Changes made between version 2.6 and version 3.0</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> — 
Getting help with GMime
</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-question-index.html">Frequently Asked Questions</a></span><span class="refpurpose"> — 
Find answers to common questions in the GMime manual
</span>
</dt>
</dl></dd>
<dt><span class="part"><a href="fundamentals.html">II. GMime Fundamentals</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-streams.html">Streams</a></span><span class="refpurpose"> — How to use Streams</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-filters.html">Stream Filters</a></span><span class="refpurpose"> — How to use Stream Filters</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-data-wrappers.html">Data Wrappers</a></span><span class="refpurpose"> — How to use Data Wrappers</span>
</dt>
</dl></dd>
<dt><span class="part"><a href="core.html">III. GMime Core Reference</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-gmime.html">gmime</a></span><span class="refpurpose"> — Initialization, shutdown and version-check routines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-charset.html">gmime-charset</a></span><span class="refpurpose"> — Charset helper functions</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-iconv.html">gmime-iconv</a></span><span class="refpurpose"> — Low-level routines for converting text from one charset to another</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-iconv-utils.html">gmime-iconv-utils</a></span><span class="refpurpose"> — High-level routines for converting text from one charset to another</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-encodings.html">gmime-encodings</a></span><span class="refpurpose"> — MIME encoding functions</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-utils.html">gmime-utils</a></span><span class="refpurpose"> — MIME utility functions</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-GMimeReferences.html">GMimeReferences</a></span><span class="refpurpose"> — a list of Message-Ids</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-GMimeFormatOptions.html">GMimeFormatOptions</a></span><span class="refpurpose"> — Format options</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-autocrypt.html">gmime-autocrypt</a></span><span class="refpurpose"></span>
</dt>
</dl></dd>
<dt><span class="part"><a href="classes.html">IV. GMime Classes</a></span></dt>
<dd><dl>
<dt><span class="chapter"><a href="ch01.html">Class hierarchy</a></span></dt>
<dt><span class="chapter"><a href="Streams.html">Streams</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamGIO.html">GMimeStreamGIO</a></span><span class="refpurpose"> — A wrapper for GLib's GIO streams</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="Filters.html">Stream Filters</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterChecksum.html">GMimeFilterChecksum</a></span><span class="refpurpose"> — Calculate a checksum</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterDos2Unix.html">GMimeFilterDos2Unix</a></span><span class="refpurpose"> — Convert line-endings from Windows/DOS (CRLF) to UNIX (LF).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterOpenPGP.html">GMimeFilterOpenPGP</a></span><span class="refpurpose"> — Detect OpenPGP markers.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterSmtpData.html">GMimeFilterSmtpData</a></span><span class="refpurpose"> — Byte-stuffs outgoing SMTP DATA.</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterUnix2Dos.html">GMimeFilterUnix2Dos</a></span><span class="refpurpose"> — Convert line-endings from UNIX (LF) to Windows/DOS (CRLF).</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="DataWrappers.html">Data Wrappers</a></span></dt>
<dd><dl><dt>
<span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span>
</dt></dl></dd>
<dt><span class="chapter"><a href="Headers.html">Message and MIME Headers</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeHeaderList.html">GMimeHeaderList</a></span><span class="refpurpose"> — Message and MIME part headers</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeParamList.html">GMimeParamList</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="InternetAddresses.html">Internet Addresses</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="MimeParts.html">MIME Messages and Parts</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeTextPart.html">GMimeTextPart</a></span><span class="refpurpose"> — textual MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeApplicationPkcs7Mime.html">GMimeApplicationPkcs7Mime</a></span><span class="refpurpose"> — Pkcs7 MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="Parsers.html">Parsing Messages and MIME Parts</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-GMimeParserOptions.html">GMimeParserOptions</a></span><span class="refpurpose"> — Parser options</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="CryptoContexts.html">Cryptography Contexts</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span>
</dt>
</dl></dd>
</dl></dd>
</dl></div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>